Contains(TCollection, TElement) Method (ConditionValidator(TCollection), TElement, String)

CuttingEdge.Conditions

previous page next page

Checks whether the given value contains the specified element. An exception is thrown otherwise. When the value is a null reference it is considered empty and therefore won't contain element.

Namespace: CuttingEdge.Conditions
Assembly: CuttingEdge.Conditions (in CuttingEdge.Conditions.dll)

Syntax

Visual Basic (Declaration)
Public Shared Function Contains(Of TCollection As IEnumerable(Of TElement), TElement) ( _ validator As ConditionValidator(Of TCollection), _ element As TElement, _ conditionDescription As String _ ) As ConditionValidator(Of TCollection)

Visual Basic (Declaration)

Public Shared Function Contains(Of TCollection As IEnumerable(Of TElement), TElement) ( _
	validator As ConditionValidator(Of TCollection), _
	element As TElement, _
	conditionDescription As String _
) As ConditionValidator(Of TCollection)

C#
public static ConditionValidator<TCollection> Contains<TCollection, TElement>( ConditionValidator<TCollection> validator, TElement element, string conditionDescription ) where TCollection : IEnumerable<TElement>

public static ConditionValidator<TCollection> Contains<TCollection, TElement>(
	ConditionValidator<TCollection> validator,
	TElement element,
	string conditionDescription
)
where TCollection : IEnumerable<TElement>

Visual C++
public: generic<typename TCollection, typename TElement> where TCollection : IEnumerable<TElement> static ConditionValidator<TCollection>^ Contains( ConditionValidator<TCollection>^ validator, TElement element, String^ conditionDescription )

Visual C++

public:
generic<typename TCollection, typename TElement>
where TCollection : IEnumerable<TElement>
static ConditionValidator<TCollection>^ Contains(
	ConditionValidator<TCollection>^ validator, 
	TElement element, 
	String^ conditionDescription
)

JavaScript
JavaScript does not support generic types or methods.

Parameters

validator: Type: CuttingEdge.Conditions..::.ConditionValidator<(Of <(TCollection>)>)
The ConditionValidator<(Of <(T>)>) that holds the value that has to be checked.

element: Type: TElement
The element that should contain the given value.

conditionDescription: Type: System..::.String
The description of the condition that should hold. The string may hold the placeholder '{0}' for the ArgumentName.

Type Parameters

TCollection: The type of the value to check.
TElement: The type that can be considered an element of the TCollection.

Return Value

The specified validator instance.

Exceptions

Exception	Condition
System..::.ArgumentException	Thrown when the Value of the specified validator does not contain element, while the specified validator is created using the Requires extension method.
System..::.ArgumentNullException	Thrown when the Value of the specified validator is a null reference, while the specified validator is created using the Requires extension method.
CuttingEdge.Conditions..::.PostconditionException	Thrown when the Value of the specified validator does not contain element, while the specified validator is created using the Ensures extension method.